<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Custom Fields</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="The Bugzilla Guide - 3.0.5  Release"
HREF="index.html"><LINK
REL="UP"
TITLE="Administering Bugzilla"
HREF="administration.html"><LINK
REL="PREVIOUS"
TITLE="Keywords"
HREF="keywords.html"><LINK
REL="NEXT"
TITLE="Legal Values"
HREF="edit-values.html"></HEAD
><BODY
CLASS="section"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The Bugzilla Guide - 3.0.5  Release</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="keywords.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 3. Administering Bugzilla</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="edit-values.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="custom-fields"
>3.10. Custom Fields</A
></H1
><P
>&#13;      One of the most requested features was the ability to add your own custom
      fields to bugs, based on your needs. With the release of Bugzilla 3.0, this
      dream finally comes true. Administrators can manage these fields using the
      <SPAN
CLASS="QUOTE"
>"Custom Fields"</SPAN
> link in the footer of pages. The first thing
      they will see is the list of existing custom fields (which is empty by default).
    </P
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="add-custom-fields"
>3.10.1. Adding Custom Fields</A
></H2
><P
>&#13;        The <SPAN
CLASS="QUOTE"
>"Add a new custom field"</SPAN
> link permits you to add a
        new field which can be either a free text box or a drop down menu.
        More field types will be available in future releases.
      </P
><P
>&#13;        The following attributes must be set for each new custom field:
        <P
></P
><UL
><LI
><P
>&#13;              <EM
>Name:</EM
>
              the name of the field, used internally. This name MUST begin
              with <SPAN
CLASS="QUOTE"
>"cf_"</SPAN
>. If you omit this string, it will
              be automatically added to the name you entered. This way, all
              custom fields added to Bugzilla begin with <SPAN
CLASS="QUOTE"
>"cf_"</SPAN
>,
              avoiding any conflict with default fields.
            </P
></LI
><LI
><P
>&#13;              <EM
>Description:</EM
>
              the string which is used as a label for this custom field.
              That is the string that users will see, and so should be
              short and explicit.
            </P
></LI
><LI
><P
>&#13;              <EM
>Type:</EM
>
              as mentioned above, only two types are implemented so far.
              Free text boxes let you type any string, while drop down menus
              only let you choose one value in the list provided. The list of
              legal values for this field can be created and edited as soon as
              this custom field is added to the DB. See
              <A
HREF="edit-values.html#edit-values-list"
>Section 3.11.1</A
> for information about editing
              legal values.
            </P
></LI
><LI
><P
>&#13;              <EM
>Sortkey:</EM
>
              this integer determines in which order custom fields are
              displayed in the UI, especially when viewing a bug. Fields
              with lower values are displayed first.
            </P
></LI
><LI
><P
>&#13;              <EM
>Can be set on bug creation:</EM
>
              this boolean determines whether this field can be set on
              bug creation or not. If not, then you have to create the
              bug first before being able to set this field. Else you
              can set its value at the same time you file a bug,
              see <A
HREF="bugreports.html"
>Section 5.6</A
> about filing bugs.
            </P
></LI
><LI
><P
>&#13;              <EM
>Displayed in bugmail for new bugs:</EM
>
              this boolean determines whether the value set on this field
              should appear in bugmail when the bug is filed. This attribute
              has no effect if the field cannot be set on bug creation.
            </P
></LI
><LI
><P
>&#13;              <EM
>Is obsolete:</EM
>
              this boolean determines whether or not this field should
              be displayed at all. Obsolete custom fields are hidden.
            </P
></LI
></UL
>
      </P
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="edit-custom-fields"
>3.10.2. Editing Custom Fields</A
></H2
><P
>&#13;        As soon as a custom field is created, its name and type cannot be
        changed. If this field is a drop down menu, its legal values can
        be set as described in <A
HREF="edit-values.html#edit-values-list"
>Section 3.11.1</A
>. All
        other attributes can be edited as described above.
      </P
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="delete-custom-fields"
>3.10.3. Deleting Custom Fields</A
></H2
><P
>&#13;        At this point, it is not possible to delete custom fields from
        your web browser. If you don't want to make one available anymore,
        mark it as obsolete. This way, you will preserve your DB
        referential integrity.
      </P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="keywords.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="edit-values.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Keywords</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="administration.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Legal Values</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>